Use two decimals for delayed scale factor #114
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is cleaner in code and it also makes it possible to provide a configurable percentage
This rebalances the bits to be more useful for anticipated values. A uint16 proves 65536 possible possibilities, but using basis points means that the values range from 0-6 with 4 decimals. As a percentage, this can represent up to 655 with two decimals.
LeoPatOZ
reviewed
May 6, 2025
Co-authored-by: Leo <[email protected]>
LeoPatOZ
approved these changes
May 9, 2025
ggonzalez94
reviewed
May 15, 2025
src/libs/LibPercentage.sol
Outdated
| /// @param value The number to scale | ||
| /// @param percentage The percentage expressed in basis points | ||
| /// @return _ The scaled value | ||
| function scaleBy(uint256 value, uint16 percentage) internal pure returns (uint96) { |
There was a problem hiding this comment.
I'm hesitant to name the two functions the same. it might be easy to get confused by anyone using the library.
What do you think about this approach?
scaleByremains the common function that takes aprecisionscaleByBpsis the bps implementationscaleByPercentageis the percentage implementation
It is more verbose, but I believe it is less error prone
test/BaseProverManager.t.sol
Outdated
Comment on lines
980
to
988
| function _calculatePercentageBPS(uint256 amount, uint16 percentage) internal pure returns (uint256) { | ||
| return amount * percentage / 10_000; | ||
| } | ||
|
|
||
| function _calculatePercentage(uint256 amount, uint16 percentage) internal pure returns (uint256) { | ||
| return amount * percentage / 100; | ||
| } | ||
|
|
||
|
|
There was a problem hiding this comment.
Should the tests just use the library? I don't think we are trying to check if the library works properly on these tests(we can create a new unit test for LibPercentage if we wanted to do this)
It now uses scaleByBPS and scaleByPercentage explicitly
Changes to gas cost
🧾 Summary (10% most significant diffs)
Full diff report 👇
|
|
Merging this now that it has 2 approves. I had to change the foundry version that is used in the CI to stable because nightly was causing a couple tests that use |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR make two changes.
Firstly, move the percentage calculations to a separate library. This is cleaner in code and it also makes it easier to use different precision amounts.
The second is to use two decimals of precision for the delayed fee percentage. As a uint16 there are 65536 possible values but in basis points we can only represent numbers between 0 and 6.5 (albeit with very high precision). With two decimals we can represent numbers up to 655 (with less precision).